/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation
**
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
**   * Redistributions of source code must retain the above copyright
**     notice, this list of conditions and the following disclaimer.
**   * Redistributions in binary form must reproduce the above copyright
**     notice, this list of conditions and the following disclaimer in
**     the documentation and/or other materials provided with the
**     distribution.
**   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
**     the names of its contributors may be used to endorse or promote
**     products derived from this software without specific prior written
**     permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
** $QT_END_LICENSE$
**
****************************************************************************/

/*! 
 *    Description: Audio player engine. 
 */

#ifndef __AUDIOENGINE_H__
#define __AUDIOENGINE_H__

// INCLUDES
#include <e32base.h>
#include <mdaaudiosampleplayer.h>

// FORWARD DECLARATIONS
class AudioPlayerPrivate;

/*!
 * This class will demonstrate the Symbian multimedia framework APIS which are used to play
 * an audio file.
 * - Play an audio file.
 * - Pause the playing file.
 * - Stop the playing file. 
 */
class CAudioPlayerEngine : public CBase, MMdaAudioPlayerCallback
{
public:
    static CAudioPlayerEngine* NewL(AudioPlayerPrivate* audioPlayerPvt);
    static CAudioPlayerEngine* NewLC(AudioPlayerPrivate* audioPlayerPvt);    
    void Play();
    void Stop();
    void Pause();    
    ~CAudioPlayerEngine();
    
private :
    /*
     * Virtual functions of Audio player class.
     */
    void MapcInitComplete(TInt aError, const TTimeIntervalMicroSeconds &/*aDuration*/);
    virtual void MapcPlayComplete(TInt aError);
  
    
private:
    void ConstructL();
    CAudioPlayerEngine(AudioPlayerPrivate* audioPlayerPvt);    
    CMdaAudioPlayerUtility* iPlayer; // Audio player utility which will call the audio playing methods.

private:
    TBool iAudioFileOpen; // This  boolean is used to know, whether an audio file is opened or not.
    TBool iAudioPlaying; // This boolean is used to know, whether an audio file is playing or not.
    AudioPlayerPrivate* iAudioPlayerPvt; // pointer handler for this class, is used to print the response on UI.

public:
    TBuf<128> iResponse; // Responses to various operations on the audio file are stored in this buffer.
    };

#endif /* AUDIOENGINE_H_ */
